fix: Prevent error when using quotation marks in BuildMessage #75
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When a PR title or commit summary contains quotation marks, they were
not escaped when injected into the JSON attachment. This caused
a message like
unable to unmarshal webhook message: invalid character 't' after object key:value pair
when used inside of a template containing this test:
```json
{
"text": "*Status*: FAILURE\n*Repo*: {{ .RepositoryName }} | *Branch*: {{ .BuildBranch }} | *Author*: {{ .BuildAuthor }}\n*Build*: {{ .BuildLink }}\n*Message*: {{ .BuildMessage }}"
}
```
This change safens this use case. Other typical fields _shouldn't_ have
quotation marks in them, but it might be prudent down the line to
cleanse _all_ fields as they are injected into the JSON or provide
a method usable inside of the template that escapes correctly.
ecrupper
previously approved these changes
Jun 27, 2024
colindean
commented
Jun 27, 2024
wass3rw3rk
reviewed
Jun 27, 2024
wass3r
previously approved these changes
Jun 28, 2024
wass3r
approved these changes
Jul 3, 2024
ecrupper
approved these changes
Jul 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When a PR title or commit summary contains quotation marks, they were not escaped when injected into the JSON attachment. This caused a message like
when used inside of a template containing this test:
{ "text": "*Status*: FAILURE\n*Repo*: {{ .RepositoryName }} | *Branch*: {{ .BuildBranch }} | *Author*: {{ .BuildAuthor }}\n*Build*: {{ .BuildLink }}\n*Message*: {{ .BuildMessage }}" }This change safens this use case. Other typical fields shouldn't have quotation marks in them, but it might be prudent down the line to cleanse all fields as they are injected into the JSON or provide a method usable inside of the template that escapes correctly.